Skip to content

docs: credit contributors inline per change (GitHub renders the row from @mentions)#49

Merged
CybotTM merged 1 commit into
mainfrom
docs/harvest-under-credit-direct-push
Jul 5, 2026
Merged

docs: credit contributors inline per change (GitHub renders the row from @mentions)#49
CybotTM merged 1 commit into
mainfrom
docs/harvest-under-credit-direct-push

Conversation

@CybotTM

@CybotTM CybotTM commented Jul 5, 2026

Copy link
Copy Markdown
Member

The skill prescribed a hand-written ## Contributors section (via harvest-contributors.sh). But GitHub already builds the Contributors avatar row above Assets from the @mentions in the release body (mentions_count) — a hand-written section duplicates it and lumps everyone together, losing who did what.

New policy

@mention each contributor inline at the change they touched, by role — reporter, PR author, committer/co-author, reviewer, discussant. No hand-written section. Example:

- Entry deletion now enforces ownership (IDOR) — reported by @alice, fixed in #560 by @bob, reviewed by @carol.

Changes

  • SKILL.md step 9 and release-process.md (Phase 5 + the crediting subsection) rewritten to the inline policy; the mechanism (mentions_count) is now explicit.
  • harvest-contributors.sh repurposed from section-generator to a who-contributed-to-what lookup (no ## Contributors output). Pure helpers and the self-test are unchanged and pass.
  • Kept the bidirectional harvest cross-check — over-credit (false #N from changelog excerpts / ​) and under-credit (direct-push and bot-authored/human-co-authored commits, e.g. copilot-swe-agent[bot] where the human is the committer/co-author).

Copilot AI review requested due to automatic review settings July 5, 2026 17:54
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions github-actions Bot added documentation Improvements or additions to documentation skill labels Jul 5, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the release process documentation to address under-credited contributors, such as those from direct pushes or human co-authors of bot commits, by adding a helper git log command. The reviewer suggested improving this command by including email addresses and sorting the output to make mapping contributors to GitHub usernames easier.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread skills/github-release/references/release-process.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the GitHub release skill’s release-process reference documentation to help detect under-credit in contributor harvesting—specifically for contributions that don’t show up as merged-PR authors (e.g., direct pushes and bot-authored commits with human co-authors/committers).

Changes:

  • Adds guidance explaining two common under-credit scenarios (direct pushes; bot-authored commits with human committer/co-authors).
  • Adds a suggested git log command to identify the committer and Co-authored-by trailer information for the relevant commit range.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/github-release/references/release-process.md Outdated
@CybotTM CybotTM changed the title docs: flag harvest under-credit for direct-push and bot-authored commits docs: contributor credit — mentions_count mechanism, inline mentions, direct-push/bot under-credit Jul 5, 2026
@CybotTM CybotTM changed the title docs: contributor credit — mentions_count mechanism, inline mentions, direct-push/bot under-credit docs: credit contributors inline per change (GitHub renders the row from @mentions) Jul 5, 2026
@CybotTM CybotTM force-pushed the docs/harvest-under-credit-direct-push branch from 5ee2485 to d49dbeb Compare July 5, 2026 18:24
…ributors row from @mentions

The skill prescribed a hand-written `## Contributors` section built by
harvest-contributors.sh. But GitHub already generates the Contributors avatar
row from the `@mentions` in the body (mentions_count); a hand-written section
duplicates that row and lumps everyone together, losing the per-change role.

Policy now: `@mention` each contributor inline at the change they touched, by
role (reporter / PR author / committer / co-author / reviewer / discussant);
never hand-write a section.

- SKILL.md step 9 and release-process.md Phase 5 + the crediting subsection
  rewritten to the inline policy.
- harvest-contributors.sh repurposed from section generator to a
  who-contributed-to-what lookup (no `## Contributors` output). Pure helpers
  (extract_pr_numbers, is_bot) and the self-test are unchanged and still pass.
- Kept the bidirectional harvest cross-check (over- and under-credit, incl.
  direct-push and bot-authored/human-co-authored commits).

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
@CybotTM CybotTM force-pushed the docs/harvest-under-credit-direct-push branch from d49dbeb to 1b9d5ff Compare July 5, 2026 18:34
@sonarqubecloud

sonarqubecloud Bot commented Jul 5, 2026

Copy link
Copy Markdown

@CybotTM CybotTM merged commit 3c23935 into main Jul 5, 2026
21 checks passed
@CybotTM CybotTM deleted the docs/harvest-under-credit-direct-push branch July 5, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skill

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants